htmldoc

NAME

SYNOPSIS

htmldoc [options] -

htmldoc [filename.book]

DESCRIPTION

The second form of HTMLDOC reads HTML source from stdin, which allows you to use HTMLDOC as a filter.

The third form of HTMLDOC launches a graphical interface that allows you to change options and generate documents interactively.  

COMMON MISTAKES

A very common mistake is to try converting a web page using:

htmldoc -f filename.pdf filename.html

which will likely produce a PDF file with no pages. To convert web page files you must use the --webpage option at the command-line or choose Web Page in the input tab of the GUI.  

OPTIONS

--bodycolor color

Specifies the background color for all pages.

--bodyfont {courier,times,helvetica}

--textfont {courier,times,helvetica}

Specifies the default typeface for all normal text.

--bodyimage filename

Specifies the background image that is tiled on all pages.

--book

Specifies that the HTML sources are structured (headings, chapters, etc.)

--bottom margin

Specifies the bottom margin in points (no suffix or ##pt), inches (##in), centimeters (##cm), or millimeters (##mm).

--charset {8859-1...8859-15}

Specifies the ISO character set to use for the output.

--color

Specifies that PostScript or PDF output should be in color.

--datadir directory

Specifies the location of the HTMLDOC data files, usually /usr/share/htmldoc or C:\Program Files\HTMLDOC.

--duplex

Specifies that the output should be formatted for double-sided printing.

--effectduration { 0.1..10.0 }

Specifies the duration in seconds of PDF page transition effects.

--encryption

Enables encryption of PDF files.

--fontsize size

Specifies the default font size for body text.

--fontspacing spacing

Specifies the default line spacing for body text. The line spacing is a multiplier for the font size, so a value of 1.2 will provide an additional 20% of space between the lines.

--footer fff

Sets the page footer to use on body pages. See the HEADERS/FOOTERS FORMATS section below.

--format format

-t format

Specifies the output format: html, ps or ps2 (PostScript Level 2), ps1 (PostScript Level 1), ps3 (PostScript Level 3), pdf or pdf12 (PDF 1.2/Acrobat 3.0), pdf11 (PDF 1.1/Acrobat 2.0), or pdf13 (PDF 1.3/Acrobat 4.0)

--gray

Specifies that PostScript or PDF output should be grayscale.

--header fff

Sets the page header to use on body pages. See the HEADERS/FOOTERS FORMATS section below.

--headfootfont font

Sets the font to use on headers and footers.

--headfootsize size

Sets the size of the font to use on headers and footers.

--headingfont typeface

Sets the typeface to use for headings.

--help

Displays a summary of command-line options.

--helpdir directory

Specifies the location of the HTMLDOC on-line help files, usually /usr/share/doc/htmldoc or C:\Program Files\HTMLDOC\DOC.

--jpeg[=quality]

Sets the JPEG compression level to use for large images. A value of 0 disables JPEG compression.

--left margin

Specifies the left margin in points (no suffix or ##pt), inches (##in), centimeters (##cm), or millimeters (##mm).

--linkcolor color

Sets the color of links.

--links

Enables generation of links in PDF files (default).

--linkstyle {plain,underline}

Sets the style of links.

--logoimage filename

Specifies an image to be used as a logo in the header or footer in a PostScript or PDF document, and in the navigation bar of a HTML document.

--no-compression

Disables compression of PostScript or PDF files.

--no-duplex

Disables double-sided printing.

--no-encryption

Disables document encryption.

--no-links

Disables generation of links in a PDF document.

--no-numbered

Disables automatic heading numbering.

--no-pscommands

Disables generation of PostScript setpagedevice commands.

--no-title

Disables generation of a title page.

--no-toc

Disables generation of a table of contents.

--no-truetype

Disables use of TrueType fonts in PDF output.

--numbered

Numbers all headings in a document.

--outdir directory

-d directory

Specifies that output should be sent to a directory in multiple files. (Not compatible with PDF output)

--outfile filename

-f filename

Specifies that output should be sent to a single file.

--owner-password password

Sets the owner password for encrypted PDF files.

--pageduration {1.0..60.0}

Sets the view duration of a page in a PDF document.

--pageeffect effect

Specifies the page transition effect for all pages; this attribute is ignored by all Adobe PDF viewers...

--pagelayout {single,one,twoleft,tworight}

Specifies the initial layout of pages for a PDF file.

--pagemode {document,outlines,fullscreen}

Specifies the initial viewing mode for a PDF file.

--path

Specifies a search path for files in a document.

--permissions permission

Specifies document permissions for encrypted PDF files. Multiple --permissions options are required to grant or deny specific permissions. The following values are understood: all, none, annotate, no-annotate, copy, no-copy, modify, no-modify, print, and no-print.

--pscommands

Specifies that PostScript setpagedevice commands should be included in the output.

--quiet

Suppresses all messages, even error messages.

--right margin

Specifies the right margin in points (no suffix or ##pt), inches (##in), centimeters (##cm), or millimeters (##mm).

--size pagesize

Specifies the page size using a standard name or in points (no suffix or ##x##pt), inches (##x##in), centimeters (##x##cm), or millimeters (##x##mm). The standard sizes that are currently recognized are "letter" (8.5x11in), "legal" (8.5x14in), "a4" (210x297mm), and "universal" (8.27x11in).

--textcolor color

Specifies the default color of all text.

--title

Enables the generation of a title page.

--titlefile filename

--titleimage filename

Specifies the file to use for the title page. If the file is an image then the title page is automatically generated using the document meta data and title image.

--tocfooter fff

Sets the page footer to use on table-of-contents pages. See the HEADERS/FOOTERS FORMATS section below.

--tocheader fff

Sets the page header to use on table-of-contents pages. See the HEADERS/FOOTERS FORMATS section below.

--toclevels levels

Sets the number of levels in the table-of-contents.

--toctitle string

Sets the title for the table-of-contents.

--top margin

Specifies the top margin in points (no suffix or ##pt), inches (##in), centimeters (##cm), or millimeters (##mm).

--truetype

Enables use of TrueType fonts in PDF output.

--user-password password

Specifies the user password for encryption of PDF files.

--verbose

-v

Provides verbose messages.

--webpage

Specifies that the HTML sources are unstructured (plain web pages.)

HEADER/FOOTER FORMATS

Each character can be one of the following:

.

blank

/

n/N arabic page numbers (1/3, 2/3, 3/3)

:

c/C arabic chapter page numbers (1/2, 2/2, 1/4, 2/4, ...)

1

arabic numbers (1, 2, 3, ...)

a

lowercase letters

A

uppercase letters

c

current chapter heading

C

current chapter page number (arabic)

d

current date

D

current date and time

h

current heading

i

lowercase roman numerals

I

uppercase roman numerals

l

logo image

t

title text

T

current time

SEE ALSO

http://www.easysw.com/htmldoc  

AUTHOR

TRADEMARKS

COPYRIGHTS

HTMLDOC is copyright 1997-2001 by Easy Software Products. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is based in part on the work of the Independent JPEG Group.  

NO WARRANTY

Index

NAME

SYNOPSIS

DESCRIPTION

COMMON MISTAKES

OPTIONS

HEADER/FOOTER FORMATS

SEE ALSO

AUTHOR

TRADEMARKS

COPYRIGHTS

NO WARRANTY